Skip to content

doc(Dropdown): custom content use ButtonTemplate #5196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jan 24, 2025
Merged

doc(Dropdown): custom content use ButtonTemplate #5196

merged 1 commit into from
Jan 24, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 24, 2025 •
edited
Loading

custom content use ButtonTemplate

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号

Description

fixes #5189

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 24, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces a new ButtonTemplate feature to the Dropdown component, allowing for custom button content. It also includes minor updates to the sample page, adding a new demo for the ButtonTemplate feature and updating existing Dropdown usages to self-close.

Class diagram showing Dropdown component changes

classDiagram
    class Dropdown {
        +TValue Value
        +IEnumerable<TValue> Items
        +bool IsFixedButtonText
        +string FixedButtonText
        +RenderFragment ButtonTemplate
    }
    note for Dropdown "Added ButtonTemplate for custom content"
Loading

File-Level Changes

Change Details Files
Added ButtonTemplate feature to the Dropdown component.
  • Added a new demo showcasing the ButtonTemplate feature.
  • The ButtonTemplate allows users to customize the dropdown button content.
 src/BootstrapBlazor.Server/Components/Samples/Dropdowns.razor
Updated Dropdown usages to self-close.
  • All Dropdown components in the sample page are now self-closing.
 src/BootstrapBlazor.Server/Components/Samples/Dropdowns.razor
Added localization keys for the new ButtonTemplate demo.
  • Added 'ButtonTemplateTitle' and 'ButtonTemplateIntro' keys to both en-US and zh-CN locale files.
 src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 24, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 24, 2025
@ArgoZhang ArgoZhang changed the title feat(Dropdown): custom content use ButtonTemplate doc(Dropdown): custom content use ButtonTemplate Jan 24, 2025
@ArgoZhang ArgoZhang added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Jan 24, 2025
sourcery-ai[bot]
sourcery-ai bot approved these changes Jan 24, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please include the localization changes for en-US.json and zh-CN.json files to support the new ButtonTemplate feature
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang enabled auto-merge (squash) January 24, 2025 05:48
@codecov
Copy link

codecov bot commented Jan 24, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7b1a2f2) to head (f054a5a).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #5196   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28169     28169           
  Branches      4053      4053           
=========================================
  Hits         28169     28169

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit 4dc56bb into main Jan 24, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the doc-dp branch January 24, 2025 05:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] approved these changes

Assignees

@ArgoZhang ArgoZhang

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

v9.2.0

Development

Successfully merging this pull request may close these issues.

feat(Dropdown): custom button use ButtonTemplate

2 participants

@ArgoZhang